Area Object

Sample Code - Area Object

The Area Object represents an area in a report. An area is a group of like sections in the report (for example, Details A - Da, Details B - Db, etc.) that all share the same characteristics. Each section within the area can be formatted differently. This object allows you to retrieve information and set options for a specified area in your report.

Area Object Properties

Property Description Read/Write

Application

Returns a reference to the Application Object, that this object is associated with.

Read only

CopiesToPrint

Returns/Sets the number of copies of each item in the Details section of the report. For example, by default, each line of the Details section only prints once. By setting this to 3, each line of the Details section would print 3 times.

Read/Write

GroupNumber

If the area is a group, this returns the group number. Otherwise, exception is thrown.

Read only

GroupOptions

Returns GroupAreaOptions Object, which provides properties/methods for getting and setting group options. Exception is thrown if area is not a group area.

Read only

Kind

Returns CRAreaKind (see table below), which specifies what "kind" of area (that is, Details, Report Header, Page Footer, etc.).

Read only


Constant Value


crDetail

4


crGroupFooter

5


crGroupHeader

3


crPageFooter

7


crPageHeader

2


crReportFooter

8


crReportHeader

1

Property Description Read/Write

Options

Returns AreaOptions Object, which provides properties for getting and setting area options (that is, new page before, keep together, etc.).

Read only

Parent

Reference to the Parent object (Area Object).

Read only

Report

Reference to Report Object.

Read only

Sections

Returns Sections Collection, which specifies a collection of all the sections in the area.

Read only



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com